Documentation Center

EventMonitor 2.5 RetrieveEventOverviewByProgressIds [internal]

Retrieves metadata of the events with the given progress ids which also match the supplied filters.


Parameters

NameTypeDirectionDescription
psAuthContextStringInOutDeprecated proprietary authentication context only used by .ASMX web services based on internal username/password authentication. Claims based security standards drive all the WCF .SVC web services making this parameter redundant.
pasEventTypesStringArrayInString array containing the event types to retrieve (e.g EXPORTFORPUBLICATION, CREATETRANSLATIONFROMREPORT,...)
peStatusFiltereProgressStatusFilterInThe enumeration indicating which overall status the event must have
pdModifiedSinceDateInA date limiting the events that will be retrieved based on the last modification date of the events
peUserFiltereUserFilterInEnumeration indicating if only events of the current user or all events must be retrieved
psXMLRequestedEventDataStringInRequested Event Metadata XML structure indicating which metadata has to be retrieved for a given event
psOutXMLEventListStringOutEvent List XML structure containing both the event data content (base 64 encoded) and the requested metadata.

Note that:
  • Only metadata of events (level progress) are retrieved. No event data and no metadata of the event details (level detail) will be retrieved. The level attribute on the ishfield elements in the parameter psXMLRequestedEventData must be 'progress'.
  • This method will calculate (if necessary) the status for each main event using the status of the sub events. If there is a status filter provided, the calculation is done before the filtering is executed.
  • If the parameter peUserFilter is set to Current, only events that are associated with the current user will be retrieved. Otherwise the events associated to all users are retrieved.